General
The <General> element of the XML configuration defines general properties required by the CygNet Well Test module, and consists of the following child elements:
- <PointScheme> — Specifies the Point Scheme used by the CygNet Well Test Module.
- <RecordRetentionDays> — Specifies the number of days to retain the well test records.
- <RelativeFacilityFile> — Specifies the path to and filename of the relative facility file.
Note: See Creating the Relative Facilities File for instructions on how to get relative facility settings from a Canvas installation.
- <RelativeFacilityFileSource> — Specifies the path type for the relative facility file. Supported options include Local or BSS.
- <RelativeFacilityDefinition> — Specifies the relative facility definition set to use for the configuration. This is only needed if there are multiple definition sets in the relative facility file.
To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.
Example
|
<WellTestConfiguration> <General> <PointScheme>1</PointScheme> <RecordRetentionDays>365</RecordRetentionDays> <RelativeFacilityFile>MYSITE.BSSCAN\GLOBAL\RelativeFacilities.xml</RelativeFacilityFile> <RelativeFacilityFileSource>BSS</RelativeFacilityFileSource> <RelativeFacilityDefinition>CygNet for Production</RelativeFacilityDefinition> </General>
…
</WellTestConfiguration> |
Properties
The <General> element has the following properties:
| Property | Description |
|---|---|
|
Case Sensitive |
Yes |
|
Required |
Yes |
|
Number of Instances Allowed |
1 |
|
Parent Element |
|
|
Child Elements |
<PointScheme> <RecordRetentionDays> <RelativeFacilityFile> <RelativeFacilityFileSource> <RelativeFacilityDefinition> |
|
Attributes |
None |
Attributes
The <General> element has no attributes.
